/**
 * Copyright (c) 2008, Andrew Carter All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer. Redistributions in binary
 * form must reproduce the above copyright notice, this list of conditions and
 * the following disclaimer in the documentation and/or other materials provided
 * with the distribution. Neither the name of Andrew Carter nor the names of
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.acarter.composabletree;

import javax.swing.Icon;


/**
 * @author Andrew Carter
 */
public interface ComposableTreeNode {

	/**
	 * Counts the number of children of this type under this parent.
	 * 
	 * @param parent
	 *            the object with the children to count
	 * @return the number of children represented by this tree node type
	 */
	public int getChildCount(Object parent);

	/**
	 * Returns the index of the child.
	 * 
	 * @param parent
	 *            the parent object
	 * @param child
	 *            the child of the parent
	 * 
	 * @return index of the child, or -1 if not a child
	 */
	public int getChildIndex(Object parent, Object child);

	/**
	 * Returns the child of the parent given the index.
	 * 
	 * @param parent
	 *            parent object
	 * @param index
	 *            Index of the child
	 * 
	 * @return the child, or null
	 */
	public Object getChild(Object parent, int index);

	/**
	 * Returns the parent object of the given child.
	 * 
	 * @param child
	 *            the child object of the desired parent.
	 * @return the parent object if possible, or null
	 */
	public Object getParent(Object child);
	
	/**
	 * Returns the class type of objects this tree node represents.
	 * 
	 * @return tree node class
	 */
	public Class<?> getNodeClassType();

	/**
	 * Returns a textual representation of this tree node.
	 * 
	 * @param node
	 *            the <code>Object</code> to convert to text
	 * @param selected
	 *            true if the node is selected
	 * @param expanded
	 *            true if the node is expanded
	 * @param leaf
	 *            true if the node is a leaf node
	 * @param row
	 *            an integer specifying the node's display row, where 0 is the
	 *            first row in the display
	 * @param hasFocus
	 *            true if the node has the focus
	 * @return the <code>String</code> representation of the node's value
	 */
	public String getNodeText(Object node, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus);

	/**
	 * Returns a meaningful tool tip description of this tree node.
	 * 
	 * @param node
	 *            the <code>Object</code> to describe
	 * @param selected
	 *            true if the node is selected
	 * @param expanded
	 *            true if the node is expanded
	 * @param leaf
	 *            true if the node is a leaf node
	 * @param row
	 *            an integer specifying the node's display row, where 0 is the
	 *            first row in the display
	 * @param hasFocus
	 *            true if the node has the focus
	 * @return the <code>String</code> description of the node
	 */
	public String getNodeToolTipText(Object node, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus);

	/**
	 * Returns a icon to be rendered in the tree.
	 * 
	 * @param object
	 *            the object the icon will represent
	 * @return the icon, or null is no icon is desired
	 */
	public Icon getIcon(Object node);
}
